home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / zlatrs.z / zlatrs
Encoding:
Text File  |  2002-10-03  |  9.0 KB  |  265 lines
  1.  
  2.  
  3.  
  4. ZZZZLLLLAAAATTTTRRRRSSSS((((3333SSSS))))                                                          ZZZZLLLLAAAATTTTRRRRSSSS((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZLATRS - solve one of the triangular systems  A * x = s*b, A**T * x =
  10.      s*b, or A**H * x = s*b,
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE ZLATRS( UPLO, TRANS, DIAG, NORMIN, N, A, LDA, X, SCALE, CNORM,
  14.                         INFO )
  15.  
  16.          CHARACTER      DIAG, NORMIN, TRANS, UPLO
  17.  
  18.          INTEGER        INFO, LDA, N
  19.  
  20.          DOUBLE         PRECISION SCALE
  21.  
  22.          DOUBLE         PRECISION CNORM( * )
  23.  
  24.          COMPLEX*16     A( LDA, * ), X( * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      ZLATRS solves one of the triangular systems A * x = s*b, A**T * x = s*b,
  41.      or A**H * x = s*b, with scaling to prevent overflow.  Here A is an upper
  42.      or lower triangular matrix, A**T denotes the transpose of A, A**H denotes
  43.      the conjugate transpose of A, x and b are n-element vectors, and s is a
  44.      scaling factor, usually less than or equal to 1, chosen so that the
  45.      components of x will be less than the overflow threshold.  If the
  46.      unscaled problem will not cause overflow, the Level 2 BLAS routine ZTRSV
  47.      is called. If the matrix A is singular (A(j,j) = 0 for some j), then s is
  48.      set to 0 and a non-trivial solution to A*x = 0 is returned.
  49.  
  50.  
  51. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  52.      UPLO    (input) CHARACTER*1
  53.              Specifies whether the matrix A is upper or lower triangular.  =
  54.              'U':  Upper triangular
  55.              = 'L':  Lower triangular
  56.  
  57.      TRANS   (input) CHARACTER*1
  58.              Specifies the operation applied to A.  = 'N':  Solve A * x = s*b
  59.              (No transpose)
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZLLLLAAAATTTTRRRRSSSS((((3333SSSS))))                                                          ZZZZLLLLAAAATTTTRRRRSSSS((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              = 'T':  Solve A**T * x = s*b  (Transpose)
  75.              = 'C':  Solve A**H * x = s*b  (Conjugate transpose)
  76.  
  77.      DIAG    (input) CHARACTER*1
  78.              Specifies whether or not the matrix A is unit triangular.  = 'N':
  79.              Non-unit triangular
  80.              = 'U':  Unit triangular
  81.  
  82.      NORMIN  (input) CHARACTER*1
  83.              Specifies whether CNORM has been set or not.  = 'Y':  CNORM
  84.              contains the column norms on entry
  85.              = 'N':  CNORM is not set on entry.  On exit, the norms will be
  86.              computed and stored in CNORM.
  87.  
  88.      N       (input) INTEGER
  89.              The order of the matrix A.  N >= 0.
  90.  
  91.      A       (input) COMPLEX*16 array, dimension (LDA,N)
  92.              The triangular matrix A.  If UPLO = 'U', the leading n by n upper
  93.              triangular part of the array A contains the upper triangular
  94.              matrix, and the strictly lower triangular part of A is not
  95.              referenced.  If UPLO = 'L', the leading n by n lower triangular
  96.              part of the array A contains the lower triangular matrix, and the
  97.              strictly upper triangular part of A is not referenced.  If DIAG =
  98.              'U', the diagonal elements of A are also not referenced and are
  99.              assumed to be 1.
  100.  
  101.      LDA     (input) INTEGER
  102.              The leading dimension of the array A.  LDA >= max (1,N).
  103.  
  104.      X       (input/output) COMPLEX*16 array, dimension (N)
  105.              On entry, the right hand side b of the triangular system.  On
  106.              exit, X is overwritten by the solution vector x.
  107.  
  108.      SCALE   (output) DOUBLE PRECISION
  109.              The scaling factor s for the triangular system A * x = s*b,  A**T
  110.              * x = s*b,  or  A**H * x = s*b.  If SCALE = 0, the matrix A is
  111.              singular or badly scaled, and the vector x is an exact or
  112.              approximate solution to A*x = 0.
  113.  
  114.      CNORM   (input or output) DOUBLE PRECISION array, dimension (N)
  115.  
  116.              If NORMIN = 'Y', CNORM is an input argument and CNORM(j) contains
  117.              the norm of the off-diagonal part of the j-th column of A.  If
  118.              TRANS = 'N', CNORM(j) must be greater than or equal to the
  119.              infinity-norm, and if TRANS = 'T' or 'C', CNORM(j) must be
  120.              greater than or equal to the 1-norm.
  121.  
  122.              If NORMIN = 'N', CNORM is an output argument and CNORM(j) returns
  123.              the 1-norm of the offdiagonal part of the j-th column of A.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZZZZLLLLAAAATTTTRRRRSSSS((((3333SSSS))))                                                          ZZZZLLLLAAAATTTTRRRRSSSS((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      INFO    (output) INTEGER
  141.              = 0:  successful exit
  142.              < 0:  if INFO = -k, the k-th argument had an illegal value
  143.  
  144. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  145.      A rough bound on x is computed; if that is less than overflow, ZTRSV is
  146.      called, otherwise, specific code is used which checks for possible
  147.      overflow or divide-by-zero at every operation.
  148.  
  149.      A columnwise scheme is used for solving A*x = b.  The basic algorithm if
  150.      A is lower triangular is
  151.  
  152.           x[1:n] := b[1:n]
  153.           for j = 1, ..., n
  154.                x(j) := x(j) / A(j,j)
  155.                x[j+1:n] := x[j+1:n] - x(j) * A[j+1:n,j]
  156.           end
  157.  
  158.      Define bounds on the components of x after j iterations of the loop:
  159.         M(j) = bound on x[1:j]
  160.         G(j) = bound on x[j+1:n]
  161.      Initially, let M(0) = 0 and G(0) = max{x(i), i=1,...,n}.
  162.  
  163.      Then for iteration j+1 we have
  164.         M(j+1) <= G(j) / | A(j+1,j+1) |
  165.         G(j+1) <= G(j) + M(j+1) * | A[j+2:n,j+1] |
  166.                <= G(j) ( 1 + CNORM(j+1) / | A(j+1,j+1) | )
  167.  
  168.      where CNORM(j+1) is greater than or equal to the infinity-norm of column
  169.      j+1 of A, not counting the diagonal.  Hence
  170.  
  171.         G(j) <= G(0) product ( 1 + CNORM(i) / | A(i,i) | )
  172.                      1<=i<=j
  173.      and
  174.  
  175.         |x(j)| <= ( G(0) / |A(j,j)| ) product ( 1 + CNORM(i) / |A(i,i)| )
  176.                                       1<=i< j
  177.  
  178.      Since |x(j)| <= M(j), we use the Level 2 BLAS routine ZTRSV if the
  179.      reciprocal of the largest M(j), j=1,..,n, is larger than
  180.      max(underflow, 1/overflow).
  181.  
  182.      The bound on x(j) is also used to determine when a step in the columnwise
  183.      method can be performed without fear of overflow.  If the computed bound
  184.      is greater than a large constant, x is scaled to prevent overflow, but if
  185.      the bound overflows, x is set to 0, x(j) to 1, and scale to 0, and a
  186.      non-trivial solution to A*x = 0 is found.
  187.  
  188.      Similarly, a row-wise scheme is used to solve A**T *x = b  or A**H *x =
  189.      b.  The basic algorithm for A upper triangular is
  190.  
  191.           for j = 1, ..., n
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ZZZZLLLLAAAATTTTRRRRSSSS((((3333SSSS))))                                                          ZZZZLLLLAAAATTTTRRRRSSSS((((3333SSSS))))
  203.  
  204.  
  205.  
  206.                x(j) := ( b(j) - A[1:j-1,j]' * x[1:j-1] ) / A(j,j)
  207.           end
  208.  
  209.      We simultaneously compute two bounds
  210.           G(j) = bound on ( b(i) - A[1:i-1,i]' * x[1:i-1] ), 1<=i<=j
  211.           M(j) = bound on x(i), 1<=i<=j
  212.  
  213.      The initial values are G(0) = 0, M(0) = max{b(i), i=1,..,n}, and we add
  214.      the constraint G(j) >= G(j-1) and M(j) >= M(j-1) for j >= 1.  Then the
  215.      bound on x(j) is
  216.  
  217.           M(j) <= M(j-1) * ( 1 + CNORM(j) ) / | A(j,j) |
  218.  
  219.                <= M(0) * product ( ( 1 + CNORM(i) ) / |A(i,i)| )
  220.                          1<=i<=j
  221.  
  222.      and we can safely call ZTRSV if 1/M(n) and 1/G(n) are both greater than
  223.      max(underflow, 1/overflow).
  224.  
  225.  
  226. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  227.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  228.  
  229.      This man page is available only online.
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.